home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / plan.z / plan / man / cat1 / plan.1
Text File  |  1994-09-18  |  7KB  |  199 lines
  1.  
  2.  
  3.  
  4. PLAN(1L)                                                             PLAN(1L)
  5.  
  6.  
  7.  
  8. NAME
  9.   plan - interactive X/Motif calendar and day planner
  10.   pland - daemon for _p_l_a_n
  11.   notifier - X/Motif text displayer for _p_l_a_n
  12.  
  13. SYNOPSIS
  14.   ppllaann [-h] [-d] [-v] [-t [D]] [-s] [-f] [-k]
  15.   ppllaann [mmdd]hhmm [_m_e_s_s_a_g_e]*
  16.   ppllaanndd [-kK]
  17.   nnoottiiffiieerr [-hdv123] [-t_t_i_t_l_e] [-i_i_c_o_n_t_i_t_l_e] [file]
  18.  
  19. DESCRIPTION
  20.   ppllaann is a schedule planner based on X/Motif. It displays a month calendar
  21.   similar to xcal, but every day box is large enough to show appointments in
  22.   small print. By pressing on a day box, the appointments for that day can be
  23.   listed and edited. This manual page describes the command line options of
  24.   ppllaann.  For information on how to use ppllaann, refer to the on-line help pages.
  25.  
  26.   ppllaann has two modes: it starts up with a window in interactive mode if
  27.   started without date/time string; with date/time on the command line it
  28.   adds an appointment to the list. Only one interactive ppllaann per user can run
  29.   at any time.
  30.  
  31.   ppllaanndd is a daemon that watches for appointment triggers. The daemon is nor-
  32.   mally started from your .sgisession or .xsession file. It puts itself in
  33.   the background. If ppllaann is started, it checks for the existence of the dae-
  34.   mon, and offers to start one if it can't find it.
  35.  
  36.   nnoottiiffiieerr displays the standard input in a window, with appropriate titles
  37.   and background colors. The only program that ever uses it is the daemon; it
  38.   is a separate program only to keep the daemon small.
  39.  
  40.   OPTIONS OF PLAN
  41.  
  42.  
  43.   --hh   List available options.
  44.  
  45.   --dd   Print fallback X resources and exit. The output can be appended
  46.        directly to the ~/.Xdefaults file for modification of the geometry,
  47.        color, and font defaults.
  48.  
  49.   --vv   Print the program version and patchlevel and exit.
  50.  
  51.   --tt [[DD]]
  52.        Print a list of today's appointments to stdout. Don't start up
  53.        interactive windows. The exit status is 0 if there are appointments on
  54.        the specified date, and 1 otherwise. If a date D is specified, print
  55.        appointments on that date. All standard date specifiers work:
  56.  
  57.        --tt ++33        Print appointments in three days
  58.  
  59.        --tt --11        Print yesterday's appointments
  60.  
  61.        --tt ttoommoorrrrooww  Print appointments for tomorrow
  62.  
  63.        --tt tthhuurrssddaayy  Print appointments for Thursday
  64.  
  65.        --tt 2255..1122..    Print appointments for Christmas, if 24-hour mode is
  66.                     selected
  67.  
  68.        --tt 1122//2255     Print appointments for Christmas, if 12-hour mode is
  69.                     selected.  12/24 hour mode is selected with the Config
  70.                     pulldown in the main window.
  71.  
  72.   --ss   Standalone, don't offer to start daemon if none exists. Without dae-
  73.        mon, no appointment alarms and warnings will trigger. If a daemon hap-
  74.        pens to exist, it is notified when the database changes, but no warn-
  75.        ing is printed if it doesn't.
  76.  
  77.   --ff   Don't fork on startup. This is useful for debugging.
  78.  
  79.   --kk   If there appears to be another ppllaann running, start up anyway. This is
  80.        useful if a /tmp/.plan<uid> file got accidentally left behind, and
  81.        plan fails to check whether the older plan still exists. This option
  82.        is largely obsolete in version 1.2.
  83.  
  84.   [[mmmmdddd]]hhhhmmmm [[mmeessssaaggee]]**
  85.        Add an appointment at mm/dd hh:mm (month/day hours:minutes). If mmdd
  86.        is not specified, today's date is used. The message, which should be
  87.        quoted if it contains shell metacharacters, is used as note string. No
  88.        menus will start up. No option may be specified.
  89.  
  90.   OPTIONS OF PLAND
  91.  
  92.  
  93.   --kk   If another daemon exists, kill it and restart.
  94.  
  95.   --KK   (cap-K) If another daemon exists, kill it and exit.
  96.  
  97.   OPTIONS OF NOTIFIER
  98.  
  99.  
  100.   --hh   List available options.
  101.  
  102.   --dd   Print fallback X resources and exit. The output can be appended
  103.        directly to the ~/.Xdefaults file for modification of the geometry,
  104.        color, and font defaults.
  105.  
  106.   --vv   Print the program version and patchlevel and exit.
  107.  
  108.   --11   Set the window background color to green (early warning).
  109.  
  110.   --22   Set the window background color to yellow (late warning).
  111.  
  112.   --33   Set the window background color to red (alarm). This is the default.
  113.  
  114.   --tt_t_i_t_l_e
  115.        Set the title string above the message text (which is read from
  116.        stdin).
  117.  
  118.   --ii_i_c_o_n_t_i_t_l_e
  119.        Set the icon title string that is printed below the mwm/4Dwm icon.
  120.  
  121.   In addition to these options, plan and notifier support the usual X options
  122.   -iconic and -geometry.
  123.  
  124.  
  125.  
  126.  
  127. FILES
  128.  
  129.   Below, DIR and LIB refer to the installation directories specified at the
  130.   beginning of the Makefile when the programs were compiled. Both are
  131.   /usr/local/bin by default. These are the directories where ppllaann and ppllaanndd
  132.   first search for executables and plan.help; next, $PLAN_PATH and $PATH are
  133.   searched, and finally, a built-in search path that also contains "." as its
  134.   last item.
  135.  
  136.   ~~//..ddaayyppllaann
  137.        Database with all public entries and configuration options of ppllaann.
  138.        See plan(4) for details.
  139.  
  140.   ~~//..ddaayyppllaann..pprriivv
  141.        Database with all private entries.
  142.  
  143.   ~~//..hhoolliiddaayy
  144.        Definition of holidays. See the help text for the "Define Holiday"
  145.        popup menu that can be installed with the Holiday pulldown.
  146.  
  147.   //ttmmpp//..ppllaannUUIIDD
  148.        Lockfile that contains the PID of ppllaann.  Used to prevent multiple ppllaann
  149.        instances, and to send HUP signals to if a non-interactive ppllaann invo-
  150.        cation changed the database. UID is the user's numerical user ID.
  151.  
  152.   //ttmmpp//..ppllaannddUUIIDD
  153.        Lockfile that contains the PID of the ppllaanndd daemon. Used to prevent
  154.        multiple daemons, and to send HUP signals to if the database changed
  155.        for any reason. UID is the user's numerical user ID.
  156.  
  157.   ppllaann
  158.        The ppllaann program.
  159.  
  160.   LLIIBB//ppllaanndd
  161.        The ppllaanndd daemon. It must be in the BIN or LIB directory, or in one of
  162.        the directories in one of the search paths.
  163.  
  164.   nnoottiiffiieerr
  165.        The nnoottiiffiieerr program. It must be in the BIN or LIB directory, or in
  166.        one of the directories in one of the search paths.
  167.  
  168.   ppllaann..hheellpp
  169.        The online help texts used by ppllaann.  It must be in the BIN or LIB
  170.        directory, or in one of the directories in one of the search paths.
  171.  
  172.   AUTHOR
  173.  
  174.   Thomas Driemeyer <thomas@bitrot.in-berlin.de>
  175.   Please send all complaints, comments, bug fixes, and porting experiences to
  176.   me. Always include your plan version as reported by "plan -v" in your mail.
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.